<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html 
     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>Class: SavepointETL</title>
  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
  <meta http-equiv="Content-Script-Type" content="text/javascript" />
  <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
  <script type="text/javascript">
  // <![CDATA[

  function popupCode( url ) {
    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
  }

  function toggleCode( id ) {
    if ( document.getElementById )
      elem = document.getElementById( id );
    else if ( document.all )
      elem = eval( "document.all." + id );
    else
      return false;

    elemStyle = elem.style;
    
    if ( elemStyle.display != "block" ) {
      elemStyle.display = "block"
    } else {
      elemStyle.display = "none"
    }

    return true;
  }
  
  // Make codeblocks hidden by default
  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
  
  // ]]>
  </script>

</head>
<body>



    <div id="classHeader">
        <table class="header-table">
        <tr class="top-aligned-row">
          <td><strong>Class</strong></td>
          <td class="class-name-in-header">SavepointETL</td>
        </tr>
        <tr class="top-aligned-row">
            <td><strong>In:</strong></td>
            <td>
                <a href="../files/etl/std_rb.html">
                etl/std.rb
                </a>
        <br />
            </td>
        </tr>

        <tr class="top-aligned-row">
            <td><strong>Parent:</strong></td>
            <td>
                <a href="ETL.html">
                ETL
               </a>
            </td>
        </tr>
        </table>
    </div>
  <!-- banner header -->

  <div id="bodyContent">



  <div id="contextContent">

    <div id="description">
      <p>
This <a href="ETL.html">ETL</a> block stores the current <a
href="ETL.html">ETL</a> status (in term of an ETLDto object) to a
persistent store (the filesystem, in the current implementation). This
allows recovery of crashed ETLs and analysis of <a href="ETL.html">ETL</a>
statuses in middle steps of operation.
</p>
<p>
Savepoints can be added to an <a href="ETL.html">ETL</a> process in two
ways:
</p>
<ul>
<li>using the global savepoint configuration options in the <a
href="ETL.html">ETL</a> config file

</li>
<li>by manually adding instances of this class into the standard <a
href="ETL.html">ETL</a> chains

</li>
</ul>

    </div>


   </div>

    <div id="method-list">
      <h3 class="section-bar">Methods</h3>

      <div class="name-list">
      <a href="#M000028">extract</a>&nbsp;&nbsp;
      <a href="#M000030">load</a>&nbsp;&nbsp;
      <a href="#M000026">new</a>&nbsp;&nbsp;
      <a href="#M000027">savepoint?</a>&nbsp;&nbsp;
      <a href="#M000029">transform</a>&nbsp;&nbsp;
      </div>
    </div>

  </div>


    <!-- if includes -->
    <div id="includes">
      <h3 class="section-bar">Included Modules</h3>

      <div id="includes-list">
        <span class="include-name"><a href="Log.html">Log</a></span>
      </div>
    </div>

    <div id="section">





      


    <!-- if method_list -->
    <div id="methods">
      <h3 class="section-bar">Public Class methods</h3>

      <div id="method-M000026" class="method-detail">
        <a name="M000026"></a>

        <div class="method-heading">
          <a href="SavepointETL.src/M000026.html" target="Code" class="method-signature"
            onclick="popupCode('SavepointETL.src/M000026.html');return false;">
          <span class="method-name">new</span><span class="method-args">(dump=false)</span>
          </a>
        </div>
      
        <div class="method-description">
          <p>
Creates a <a href="SavepointETL.html#M000026">new</a> instance of the
class. The <tt>dump</tt> option defines if this savepoint is working in
dump-mode. When in dump-mode, the savepoint will not try to delete any
previous savepoint when storing a <a
href="SavepointETL.html#M000026">new</a> one, so that the whole savepoint
history is preserved at the end of the <a href="ETL.html">ETL</a>
execution.
</p>
        </div>
      </div>

      <h3 class="section-bar">Public Instance methods</h3>

      <div id="method-M000028" class="method-detail">
        <a name="M000028"></a>

        <div class="method-heading">
          <a href="SavepointETL.src/M000028.html" target="Code" class="method-signature"
            onclick="popupCode('SavepointETL.src/M000028.html');return false;">
          <span class="method-name">extract</span><span class="method-args">(dto, context)</span>
          </a>
        </div>
      
        <div class="method-description">
          <p>
Stores the current <a href="ETL.html">ETL</a> status (an ETLDto object) to
the persisten store. Due to the nature of DTOs, the file contains data in
the JSON format.
</p>
        </div>
      </div>

      <div id="method-M000030" class="method-detail">
        <a name="M000030"></a>

        <div class="method-heading">
          <a href="SavepointETL.src/M000030.html" target="Code" class="method-signature"
            onclick="popupCode('SavepointETL.src/M000030.html');return false;">
          <span class="method-name">load</span><span class="method-args">(dto,context)</span>
          </a>
        </div>
      
        <div class="method-description">
          <p>
Stores the current <a href="ETL.html">ETL</a> status (an ETLDto object) to
the persisten store. Due to the nature of DTOs, the file contains data in
the JSON format.
</p>
        </div>
      </div>

      <div id="method-M000027" class="method-detail">
        <a name="M000027"></a>

        <div class="method-heading">
          <a href="SavepointETL.src/M000027.html" target="Code" class="method-signature"
            onclick="popupCode('SavepointETL.src/M000027.html');return false;">
          <span class="method-name">savepoint?</span><span class="method-args">()</span>
          </a>
        </div>
      
        <div class="method-description">
          <p>
A marker method which identifies this block as a savepoint. This method
always returns <tt>true</tt>
</p>
        </div>
      </div>

      <div id="method-M000029" class="method-detail">
        <a name="M000029"></a>

        <div class="method-heading">
          <a href="SavepointETL.src/M000029.html" target="Code" class="method-signature"
            onclick="popupCode('SavepointETL.src/M000029.html');return false;">
          <span class="method-name">transform</span><span class="method-args">(dto, context)</span>
          </a>
        </div>
      
        <div class="method-description">
          <p>
Stores the current <a href="ETL.html">ETL</a> status (an ETLDto object) to
the persisten store. Due to the nature of DTOs, the file contains data in
the JSON format.
</p>
        </div>
      </div>


    </div>


  </div>


<div id="validator-badges">
  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
</div>

</body>
</html>